<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>S110_nRF51822/Source/ble/ble_flash.c Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css" />
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="alias.css" rel="stylesheet" type="text/css" />
<script type="text/javascript" src="alias.js"></script>

<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { searchBox.OnSelectItem(0); });
</script>


<script type="text/javascript">
  jQuery(document).ready(function () {
    if(gref){ // Number all _img and _table classes
      gref();
    }
  });
</script>

</head>
<body>
<div id="top"><!-- do not remove this div! -->

<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  
  
  <td style="padding-left: 0.5em;">
   <div id="projectname">nRF51822 BLE SDK
   
   </div>
   
  </td>
  
  
  
 </tr>
 </tbody>
</table>
</div>

<!-- Generated by Doxygen 1.7.5 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="modules.html"><span>Modules</span></a></li>
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li class="current"><a href="files.html"><span>Files</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="files.html"><span>File&#160;List</span></a></li>
      <li><a href="globals.html"><span>Globals</span></a></li>
    </ul>
  </div>
</div>
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
  initNavTree('ble__flash_8c.html','');
</script>
<div id="doc-content">
<div class="header">
  <div class="headertitle">
<div class="title">S110_nRF51822/Source/ble/ble_flash.c</div>  </div>
</div>
<div class="contents">
<div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/* Copyright (c) 2012 Nordic Semiconductor. All Rights Reserved.</span>
<a name="l00002"></a>00002 <span class="comment"> *</span>
<a name="l00003"></a>00003 <span class="comment"> * The information contained herein is property of Nordic Semiconductor ASA.</span>
<a name="l00004"></a>00004 <span class="comment"> * Terms and conditions of usage are described in detail in NORDIC</span>
<a name="l00005"></a>00005 <span class="comment"> * SEMICONDUCTOR STANDARD SOFTWARE LICENSE AGREEMENT.</span>
<a name="l00006"></a>00006 <span class="comment"> *</span>
<a name="l00007"></a>00007 <span class="comment"> * Licensees are granted free, non-transferable use of the information. NO</span>
<a name="l00008"></a>00008 <span class="comment"> * WARRANTY of ANY KIND is provided. This heading must NOT be removed from</span>
<a name="l00009"></a>00009 <span class="comment"> * the file.</span>
<a name="l00010"></a>00010 <span class="comment"> *</span>
<a name="l00011"></a>00011 <span class="comment"> * $LastChangedRevision$</span>
<a name="l00012"></a>00012 <span class="comment"> */</span>
<a name="l00013"></a>00013 
<a name="l00014"></a>00014 <span class="preprocessor">#include &quot;<a class="code" href="ble__flash_8h.html">ble_flash.h</a>&quot;</span>
<a name="l00015"></a>00015 <span class="preprocessor">#include &lt;stdlib.h&gt;</span>
<a name="l00016"></a>00016 <span class="preprocessor">#include &lt;stdint.h&gt;</span>
<a name="l00017"></a>00017 <span class="preprocessor">#include &lt;string.h&gt;</span>
<a name="l00018"></a>00018 <span class="preprocessor">#include &quot;<a class="code" href="nordic__common_8h.html" title="Common defines and macros for firmware developed by Nordic Semiconductor.">nordic_common.h</a>&quot;</span>
<a name="l00019"></a>00019 <span class="preprocessor">#include &quot;nrf_error.h&quot;</span>
<a name="l00020"></a>00020 <span class="preprocessor">#include &quot;nrf.h&quot;</span>
<a name="l00021"></a>00021 <span class="preprocessor">#include &quot;nrf51_bitfields.h&quot;</span>
<a name="l00022"></a>00022 <span class="preprocessor">#include &quot;<a class="code" href="ble__sdk__util_8h.html">ble_sdk_util.h</a>&quot;</span>
<a name="l00023"></a>00023 
<a name="l00024"></a>00024 
<a name="l00025"></a>00025 <span class="preprocessor">#define BLE_FLASH_MAGIC_NUMBER 0x45DEAD55   </span>
<a name="l00027"></a>00027 <span class="preprocessor">static uint16_t s_flash_page_size;          </span>
<a name="l00028"></a>00028 <span class="preprocessor">static uint8_t  s_elem_size;                </span>
<a name="l00035"></a>00035 <span class="preprocessor">static void flash_page_erase(uint32_t * p_page)</span>
<a name="l00036"></a>00036 <span class="preprocessor"></span>{
<a name="l00037"></a>00037     <span class="comment">// Turn on flash erase enable and wait until the NVMC is ready</span>
<a name="l00038"></a>00038     NRF_NVMC-&gt;CONFIG = (NVMC_CONFIG_WEN_Een &lt;&lt; NVMC_CONFIG_WEN_Pos);
<a name="l00039"></a>00039     <span class="keywordflow">while</span> (NRF_NVMC-&gt;READY == NVMC_READY_READY_Busy)
<a name="l00040"></a>00040     {
<a name="l00041"></a>00041         <span class="comment">// Do nothing</span>
<a name="l00042"></a>00042     }
<a name="l00043"></a>00043 
<a name="l00044"></a>00044     <span class="comment">// Erase page</span>
<a name="l00045"></a>00045     NRF_NVMC-&gt;ERASEPAGE = (uint32_t)p_page;
<a name="l00046"></a>00046     <span class="keywordflow">while</span> (NRF_NVMC-&gt;READY == NVMC_READY_READY_Busy)
<a name="l00047"></a>00047     {
<a name="l00048"></a>00048         <span class="comment">// Do nothing</span>
<a name="l00049"></a>00049     }
<a name="l00050"></a>00050 
<a name="l00051"></a>00051     <span class="comment">// Turn off flash erase enable and wait until the NVMC is ready</span>
<a name="l00052"></a>00052     NRF_NVMC-&gt;CONFIG &amp;= ~(NVMC_CONFIG_WEN_Een &lt;&lt; NVMC_CONFIG_WEN_Pos);
<a name="l00053"></a>00053     <span class="keywordflow">while</span> (NRF_NVMC-&gt;READY == NVMC_READY_READY_Busy)
<a name="l00054"></a>00054     {
<a name="l00055"></a>00055         <span class="comment">// Do nothing</span>
<a name="l00056"></a>00056     }
<a name="l00057"></a>00057 }
<a name="l00058"></a>00058 
<a name="l00059"></a>00059 
<a name="l00065"></a>00065 <span class="keyword">static</span> <span class="keywordtype">void</span> flash_word_write(uint32_t * p_address, uint32_t value)
<a name="l00066"></a>00066 {
<a name="l00067"></a>00067     <span class="comment">// Turn on flash write enable and wait until the NVMC is ready</span>
<a name="l00068"></a>00068     NRF_NVMC-&gt;CONFIG = (NVMC_CONFIG_WEN_Wen &lt;&lt; NVMC_CONFIG_WEN_Pos);
<a name="l00069"></a>00069     <span class="keywordflow">while</span> (NRF_NVMC-&gt;READY == NVMC_READY_READY_Busy)
<a name="l00070"></a>00070     {
<a name="l00071"></a>00071         <span class="comment">// Do nothing</span>
<a name="l00072"></a>00072     }
<a name="l00073"></a>00073     *p_address = value;
<a name="l00074"></a>00074 
<a name="l00075"></a>00075     <span class="comment">// Turn off flash write enable and wait until the NVMC is ready</span>
<a name="l00076"></a>00076     NRF_NVMC-&gt;CONFIG = (NVMC_CONFIG_WEN_Ren &lt;&lt; NVMC_CONFIG_WEN_Pos);
<a name="l00077"></a>00077     <span class="keywordflow">while</span> (NRF_NVMC-&gt;READY == NVMC_READY_READY_Busy)
<a name="l00078"></a>00078     {
<a name="l00079"></a>00079         <span class="comment">// Do nothing</span>
<a name="l00080"></a>00080     }
<a name="l00081"></a>00081 }
<a name="l00082"></a>00082 
<a name="l00083"></a>00083 
<a name="l00084"></a><a class="code" href="group__ble__flash__module.html#gae80848c09ea4534c232ecc19fe5c1221">00084</a> <span class="keywordtype">void</span> <a class="code" href="group__ble__flash__module.html#gae80848c09ea4534c232ecc19fe5c1221" title="Initializes the flash manager.">ble_flash_init</a>(uint8_t elem_size)
<a name="l00085"></a>00085 {
<a name="l00086"></a>00086     s_flash_page_size = (uint16_t)NRF_FICR-&gt;CODEPAGESIZE;
<a name="l00087"></a>00087     s_elem_size       = elem_size;
<a name="l00088"></a>00088 }
<a name="l00089"></a>00089 
<a name="l00090"></a>00090 
<a name="l00091"></a><a class="code" href="group__ble__flash__module.html#gac63ba6cc6f4b138d9a7d6ac9d734b30b">00091</a> <span class="keywordtype">void</span> <a class="code" href="group__ble__flash__module.html#gac63ba6cc6f4b138d9a7d6ac9d734b30b" title="Erases a flash page.">ble_flash_page_erase</a>(uint8_t page_num)
<a name="l00092"></a>00092 {
<a name="l00093"></a>00093     uint32_t * p_page = (uint32_t *)(s_flash_page_size * page_num);    
<a name="l00094"></a>00094     flash_page_erase(p_page);
<a name="l00095"></a>00095 }
<a name="l00096"></a>00096 
<a name="l00097"></a>00097 
<a name="l00098"></a><a class="code" href="group__ble__flash__module.html#ga4aef9cc7c514d95befafb92d35d8a4a0">00098</a> uint32_t <a class="code" href="group__ble__flash__module.html#ga4aef9cc7c514d95befafb92d35d8a4a0" title="Writes the flash at the given page with the given data.">ble_flash_write</a>(uint8_t page_num, uint32_t * p_in_array, uint8_t elem_count)
<a name="l00099"></a>00099 {
<a name="l00100"></a>00100     <span class="keywordtype">int</span>        i;
<a name="l00101"></a>00101     <span class="keywordtype">int</span>        word_count = <a class="code" href="group__ble__sdk__lib__util.html#ga7aaa817cfd7ed354f09db5675ffe1427" title="Perform integer division, making sure the result is rounded up.">CEIL_DIV</a>((uint16_t)elem_count * s_elem_size, <span class="keyword">sizeof</span>(uint32_t));
<a name="l00102"></a>00102     uint32_t * p_page;
<a name="l00103"></a>00103     uint32_t * p_curr_addr;
<a name="l00104"></a>00104     
<a name="l00105"></a>00105     p_page      = (uint32_t *)(s_flash_page_size * page_num);
<a name="l00106"></a>00106     p_curr_addr = p_page;
<a name="l00107"></a>00107 
<a name="l00108"></a>00108     <span class="comment">// Erase flash page</span>
<a name="l00109"></a>00109     flash_page_erase(p_page);
<a name="l00110"></a>00110 
<a name="l00111"></a>00111     <span class="comment">// Reserve space for magic number (for detecting if flash content is valid)</span>
<a name="l00112"></a>00112     p_curr_addr++;
<a name="l00113"></a>00113     
<a name="l00114"></a>00114     <span class="comment">// Reserve space for saving elem_count</span>
<a name="l00115"></a>00115     p_curr_addr++;
<a name="l00116"></a>00116 
<a name="l00117"></a>00117     <span class="comment">// Write data</span>
<a name="l00118"></a>00118     <span class="keywordflow">for</span> (i = 0; i &lt; word_count; i++)
<a name="l00119"></a>00119     {
<a name="l00120"></a>00120         flash_word_write(p_curr_addr, p_in_array[i]);
<a name="l00121"></a>00121         p_curr_addr++;
<a name="l00122"></a>00122     }
<a name="l00123"></a>00123     
<a name="l00124"></a>00124     <span class="comment">// Write number of elements</span>
<a name="l00125"></a>00125     flash_word_write(p_page + 1, (uint32_t)(elem_count));
<a name="l00126"></a>00126     
<a name="l00127"></a>00127     <span class="comment">// Write magic number to indicate that flash content is valid</span>
<a name="l00128"></a>00128     flash_word_write(p_page, BLE_FLASH_MAGIC_NUMBER);
<a name="l00129"></a>00129     
<a name="l00130"></a>00130     <span class="keywordflow">return</span> <a class="code" href="group__nrf__error.html#ga7e6367efeaac363d8cf024940b4ec123" title="Successful command.">NRF_SUCCESS</a>;
<a name="l00131"></a>00131 }
<a name="l00132"></a>00132 
<a name="l00133"></a>00133 
<a name="l00134"></a><a class="code" href="group__ble__flash__module.html#ga6602056a8dbec6f010b5f717fed92bf8">00134</a> uint32_t <a class="code" href="group__ble__flash__module.html#ga6602056a8dbec6f010b5f717fed92bf8" title="Reads data from flash to RAM.">ble_flash_read</a>(uint8_t page_num, uint32_t * p_out_array, uint8_t * p_elem_count)
<a name="l00135"></a>00135 {
<a name="l00136"></a>00136     <span class="keywordtype">int</span>        byte_count;
<a name="l00137"></a>00137     uint32_t * p_page;
<a name="l00138"></a>00138     uint32_t * p_curr_addr;
<a name="l00139"></a>00139     
<a name="l00140"></a>00140     p_page      = (uint32_t *)(s_flash_page_size * page_num);    
<a name="l00141"></a>00141     p_curr_addr = p_page;
<a name="l00142"></a>00142     
<a name="l00143"></a>00143     <span class="comment">// Check if block is valid</span>
<a name="l00144"></a>00144     <span class="keywordflow">if</span> (*p_curr_addr != BLE_FLASH_MAGIC_NUMBER)
<a name="l00145"></a>00145     {
<a name="l00146"></a>00146         <span class="keywordflow">return</span> <a class="code" href="group__nrf__error.html#ga349d25ada15be023e0d507f45ada682c" title="Not found.">NRF_ERROR_NOT_FOUND</a>;
<a name="l00147"></a>00147     }
<a name="l00148"></a>00148     p_curr_addr++;
<a name="l00149"></a>00149 
<a name="l00150"></a>00150     <span class="comment">// Read number of elements</span>
<a name="l00151"></a>00151     *p_elem_count = (uint8_t)(*(p_curr_addr));
<a name="l00152"></a>00152     p_curr_addr++;
<a name="l00153"></a>00153     
<a name="l00154"></a>00154     <span class="comment">// Read data</span>
<a name="l00155"></a>00155     byte_count = (*p_elem_count) * s_elem_size;
<a name="l00156"></a>00156     memcpy(p_out_array, p_curr_addr, byte_count);
<a name="l00157"></a>00157     
<a name="l00158"></a>00158     <span class="keywordflow">return</span> <a class="code" href="group__nrf__error.html#ga7e6367efeaac363d8cf024940b4ec123" title="Successful command.">NRF_SUCCESS</a>;
<a name="l00159"></a>00159 }
</pre></div></div>
</div>
  <div id="nav-path" class="navpath">
    <ul>
      <li class="navelem"><b>ble_flash.c</b>      </li>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Defines</a></div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>


    <li class="footer">
      Copyright &copy 2006-2011 <a href="http://www.nordicsemi.no" style="text-decoration:none">Nordic Semiconductor</a>.
      All Rights Reserved.
      <a href="disclaimer.html">Disclaimer</a>
    </li>
   </ul>
 </div>


</body>
</html>
